docs: Document Authorization: Bearer for HTTP API auth#1746
Merged
Conversation
HTTP routes now accept the API key in either `X-API-Key` or
`Authorization: Bearer ${api_key}`. The Bearer scheme matching is
case-insensitive. When both headers are present `X-API-Key` takes
precedence.
Source: spiceai/spiceai#10911
✅ Pull with Spice PassedPassing checks:
|
|
🚀 deployed to https://f74182c6.spiceai-org-website.pages.dev |
lukekim
approved these changes
May 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new
Authorization: Bearer ${api_key}header support for HTTP API authentication added in spiceai/spiceai#10911. Previously the docs only mentioned theX-API-Keyheader for HTTP routes.Source PRs
responses_adapterfix spiceai#10911 — AddsAuthorization: Bearerto the API key auth path for HTTP routes alongside the existingX-API-Key. Bearer scheme matching is case-insensitive;X-API-Keytakes precedence when both headers are present.Changes
website/docs/api/auth/index.md— extend the HTTP section to note that eitherX-API-KeyorAuthorization: Bearer ${api_key}is accepted, with acurlexample for the Bearer form.Test plan
cd website && npm run buildpasses locally (Docusaurus throws on broken links and undefined frontmatter tags)